home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 051-075 / scopedisk54 / addicon / addicon.doc < prev    next >
Text File  |  1995-03-18  |  7KB  |  162 lines
  1.  
  2.                          AddIcon Utility Program
  3.                               Documentation
  4.  
  5.                                Version 1.0
  6.                                 20-Nov-87
  7.  
  8.                                by Don Meyer
  9.  
  10.  
  11.  
  12.   This is a little utility program which will 'create' (actually 
  13. 'clone') icons for files which do not already have one.  The icons 
  14. which are used as the templates are stored in a directory which MUST 
  15. be named AddIcon_Icons.  These icons may be changed, replaced, or 
  16. deleted at will.  The default tool and the tooltypes stored in the 
  17. .info file will be carried over to the new icon.  The program does not
  18. care what type the icons are, i.e. it will allow you to set up a TOOL 
  19. type icon for a text file etc.  This is not a good thing to do!
  20.   AddIcon may be run from either the Workbench or a CLI.
  21.   The program will ask for a directory name (if run from Workbench).  
  22. This may be any valid directory such as DF0:, DF1:, SYS:, DF0:games/
  23. board  etc.
  24.  
  25. From CLI:
  26. ---------
  27.   From the CLI AddIcon will process only one directory per invocation.
  28.   Also note that the directory AddIcon_Icons must be IN the current 
  29. directory.  This is very important, otherwise no icons will be added. 
  30. I.E. doing a DIR should show you a list of directorys and files, one 
  31. of which should be  AddIcon_Icons (dir).
  32.  
  33.  
  34. From Workbench:
  35. ---------------
  36.   Double clicking on the AddIcon icon will cause a window to open and 
  37. ask for a directory name.  To exit from the program, merely enter an 
  38. empty line (just press RETURN).  The directory name/path given must be
  39. relative to the directory which contains the AddIcon program.  Or of
  40. course it could also be an absolute name, i.e. DF0:My/Stuff.
  41.   The directory AddIcon_Icons must be in the same directory as the 
  42. AddIcon program or no icons will be created.
  43.  
  44.  
  45. What Determines The Specific Icon To Add:
  46. -----------------------------------------
  47.   The first and most obvious criteria is wether it is a drawer or not.
  48.   If so, the icon for a drawer is added.
  49.   If it is not a drawer, things get a bit more complicated.  The file 
  50. extension is then looked at, and an icon added based upon that.
  51.   If there is no extension, or the extension is unknown, real 
  52. complications set in.  The contents of the file are then examined in 
  53. an attempt to figure out what it is.  Welcome to Artificial 
  54. Intelligence :-)
  55. The details of the various tests are, well, rather detailed, so I 
  56. won't go into them.  Suffice it to say that in most cases it will 
  57. guess corectly or add the general purpose "Unknown Type" icon.  I am 
  58. not familiar (can't be!) with every file format out there.  Do not be 
  59. too surprised if on occasion you get a nice familiar icon attached to 
  60. a very odd file!  This will cause no damage, and the icon can be 
  61. removed by typing (from the CLI):
  62.       DELETE <name>.info
  63.  
  64.  
  65. Customizing:
  66. ------------
  67.   You have control over the actual icon which is added for a 
  68. particular type of file.  Just take the icon in the AddIcon_Icons 
  69. directory and make it whatever you want it to be!  The icons in there 
  70. are MY choices, I would be surprised if they matched yours exactly.
  71.   You can also control (somewhat) if file extensions are used to 
  72. decide the icon type.  The main reason for this is IFF picture files. 
  73. Files created by Images will have either the .pic or .hpic extensions,
  74. and AddIcon will normally take the lazy way out and add an icon based 
  75. upon these.  There are cases in which a file with a .pic extension is 
  76. not lo-res.  If this is a problem (the only thing which would happen 
  77. is that an icon indicating the wrong resolution would be added) you 
  78. can delete the .pic icon in the Addicon_Icons directory.  This will 
  79. cause AddIcon to exert itself  :-)  and delve into the file to find 
  80. out the real resolution and type.
  81.   The above mentions an important point.  Although you can not modify 
  82. this program to, for example, add a Cherry Pie icon to all files with
  83. a .pie extension, you can keep it from adding files.  For example, if 
  84. you don't want to create icons for Aegis Images color maps, then 
  85. delete (or change the name of) the icon named "palette" in the 
  86. AddIcon_Icons directory.
  87.   This same principle applies to the IFF picture file icons.  AddIcon
  88. will attempt to add an icon which indicates the resolution and type
  89. (HAM or normal ILBM).  If you want the same icon for all your files,
  90. merely delete the specific icon or icons you do not want.  This will
  91. cause the generic ILBM icon to be added instead of the specific ILBM
  92. icon.
  93.  
  94.  
  95.  
  96. The Current Icons:
  97. ------------------
  98.  
  99. dir           for directorys
  100. blank         for text files
  101. doc           for .DOC files
  102. forth         for FORTH stream file source code
  103. arc           for .ARC files
  104. ILBM-lo       320x200 IFF pictures
  105. ILBM-lo-i     320x400 IFF pictures
  106. ILBM-med      640x200 IFF pictures
  107. ILBM-hi       640x400 IFF pictures
  108. HAM-lo        320x200 Hold&Modify IFF pictures
  109. HAM-lo-i      320x400 Hold&Modify IFF pictures
  110. ILBM          unknown IFF pictures
  111. unknown       totaly unknown file type
  112. palette       Aegis Images .col files
  113. window        Aegis Images .win files
  114. scene         Sculpt-3D scene files
  115. image         Sculpt-3D image files
  116. zoo           .ZOO archives
  117. 'c'           for C language source files
  118. 'h'           for C language header files
  119.  
  120.  
  121.  
  122. The Future:
  123. -----------
  124.   Some things that may happen...
  125.  
  126. * A intuition-style window with a string gadget (likely), perhaps a 
  127. directory name requester (less likely).
  128.  
  129. * Setable directory for source icons.  And changeable icon names
  130. (allow you hard-disk types to pull icons from your master icon drawer).
  131.  
  132.  
  133. * A means to implement your own .extension tests, see the pie above!
  134.  
  135. * Automatic directory traversal.  This would allow it to be turned 
  136. loose and run through every subdirectory, happily sowing icons as it 
  137. goes.
  138.  
  139.  
  140.  
  141. Business Stuff:
  142. ---------------
  143.   I don't feel that I should call this shareware and ask for money.  
  144. Please send your shareware $s to the REAL shareware out there, the 
  145. programs which people have devoted infinitly more time and effort to
  146. develop than I have on Addicon.  Feel free to distribute this in any 
  147. non-profit fashion.
  148.   However, please do send me any comments or (cringe) bug reports.  
  149. This is written in Multi-FORTH and source is available (assuming I can
  150. bring myself to let anybody see my code before it is cleaned up.  Hmm,
  151. yeah, just one more little change to the structure of this routine...).
  152.   Send comments, and okay, even $$ if anyone out there is moved "above 
  153. and beyond"  :-)  to:
  154.  
  155.       Don Meyer
  156.       7 Homestead
  157.       St. Peters, MO 63376
  158.  
  159.       Compuserve: 72106,23
  160.            GEnie: D.MEYER
  161.  
  162.